Skip to main content

Setup Background Jobs for your Rails application

Should you require a background process for a worker such as Sidekiq, Good job, or Delayed Job, you can setup a worker command.

Creating a Worker​

info

Some active job backends such as Sidekiq require a key-value store such as Redis to store job data. In case you haven't set up Redis, you can follow the instructions here.

To add a worker to a running application, we can use the nctl update application command. The following example demonstrates how to add a Sidekiq worker to an application:

nctl update application {application_name} \
  --worker-job-command="bundle exec sidekiq -C config/sidekiq.yml" \
  --worker-job-name "sidekiq" \
  --worker-job-size micro

The --worker-job-command flag specifies the command to run the worker. The --worker-job-name flag specifies the name of the worker, and finally, the --worker-job-size flag specifies the instance type for the worker, which are the equivalent of the instance types for the application. The available sizes can be viewed here.

Observing a Worker​

The worker's logs are aggregated with the application logs. You can view the all the logs using the nctl logs command. If you wish to only view the logs for the worker, you can filter the logs using the -t, --type flag:

nctl logs {application_name} -t worker_job

Removing a Worker​

Should you wish to remove a worker from a running application, you can use the nctl update application command:

nctl update application {application_name} --delete-worker-job={worker_job_name}

Next Steps​

Do you need to configure the CD? Proceed to the next step.

Mountain Background